home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 1 / LIGHT-ROM 1 (Amiga Library Services)(1994).iso / ffdisks / d923.lha / MagicPubName / MagicPubName.doc < prev    next >
Text File  |  1993-10-07  |  5KB  |  112 lines
  1.  
  2.     --------------------------------------------------------------------
  3.     MagicPubName 1.3a (6.8.93) © Franz.Schwarz@mil.ka.sub.org - Freeware
  4.     --------------------------------------------------------------------
  5.  
  6.  
  7. MagicPubName is, as its name already implies, a small yet powerful utility,
  8. that can be used to inquire the name of a certain public screen.  The
  9. characteristics, the public screen must meet, can be specified by a bunch
  10. of versatile command line arguments.  This makes this utility superior to
  11. the many other GetPubName-utilities available right now.
  12. Starting with version 1.2, GetPubName has also the ability to pop the
  13. resulting public screen to the front.
  14.  
  15.  
  16. The command line arguments stencil of MagicPubName is
  17.  
  18. RequireVisible=RV/S,RequireFront=RF/S,Default/S,Shanghai/S,ConsoleScr=Con/S
  19.         ScreenName=Scr,Case/S,WBOnFailure=WBF/S,ToFront/S,Quiet=Q/S
  20.  
  21.  
  22. All of them are cumulative, except the Case/S switch which may only be
  23. specified in conjunction with the ScreenName=Scr argument.  The public
  24. screen is filtered by testing all public screens to meet all the
  25. characteristics specified on the command line.  If one such screen is
  26. found, its public screen name is written to stdout.  Otherwise no write
  27. takes place, and the MagicPubName returns WARN (5) for failure.  However,
  28. if you specify the WBOnFailure=WBF/S switch or if you passed no command
  29. line arguments apart from ToFront/S & Quiet=Q/S, in case of WARN return,
  30. the name of the default public screen is written, or, if that name can't be
  31. determined, simply "Workbench".
  32.  
  33. Let's discuss now each argument and its filter characteristic:
  34.  
  35. RequireVisible=RV/S:  requires that (at least parts of) a matching public
  36. screen must be visible.
  37.  
  38. RequireFront=RF/S:  requires that a matching public screen must be the
  39. system's frontmost screen.
  40.  
  41. Default/S:  requires that a matching public screen must be system's default
  42. public screen.
  43.  
  44. Shanghai/S:  requires that a matching public screen must be the screen, on
  45. which windows with a WBENCHSCREEN-NewScreen.Type entry (e.g.  CON:  windows
  46. without a '/SCREEN...' specification in their name) are opened.
  47.  
  48. ConsoleScr=Con/S:  requires that a matching public screen must be the
  49. screen, on which the console window of the stdin interactive input chanel
  50. is opened.
  51.  
  52. ScreenName=Scr:  requires that the public screen name of a matching public
  53. screen matches exactly the given name if the Case/S switch is also
  54. specified.  Otherwise, the mentioned names must match at least without case
  55. sensitivity.
  56.  
  57. Case/S:  this switch is only valid in connection with the ScreenName=Scr
  58. argument - otherwise FAIL (20) is returned, and execution is halted.
  59.  
  60. WBOnFailure=WBF/S:  this switch makes MagicPubName write the name of the
  61. default public screen, or simply "Workbench" to stdout in case of WARN (5)
  62. return code instead of omitting any output in that case.
  63.  
  64. ToFront/S:  this switch makes MagicPupName pop the public screen, whose
  65. name is output, to the front.
  66.  
  67. Quiet=Q/S:  instructs MagicPubName to be quiet (i.e.  not to output
  68. anything) unless it fails with a return code greater than Dos.warn (5)
  69.  
  70. f none of the arguments RequireFront=RF/S, Default/S, Shanghai/S,
  71. ConsoleScr=Con/S and ScreenName=Scr is provided, the frontmost (partially)
  72. visible public screen, or in case no public screen is visible the system's
  73. default public screen, is considered to match if it complies to the
  74. characteristics of possible other filter arguments.
  75.  
  76.  
  77. The WARN (5) return for 'no matching public screen' and the ConsoleScr=Con
  78. argument, amongst the other filter arguments, predestine MagicPubName for
  79. versatile usage in ARexx scripts and batch files.
  80.  
  81. In order to get MagicPubName work together with existing ARexx scripts,
  82. batch files and alias definitions without complications, you ought to copy
  83. MagicPubName to your c:  drawer, and then create a link to it with
  84. 'MakeLink c:GetPubName c:MagicPubName Hard'.  This makes it available under
  85. the name of the common, trivial GetPubName utilities, too.
  86.  
  87. Since MagicPubName is pure and brief, yet powerful, it's highly recommened
  88. that you make MagicPubName resident.
  89.  
  90.  
  91. MagicPubName is Freeware, i.e., it's freely distributable _and_ the
  92. author holds the copyright for it.  A word about the author's
  93. liability:  it does not exist at all in any way whatsoever.  You use
  94. this software definitively at your own risk.
  95.  
  96.  
  97.  
  98.  
  99.              MagicPubName written and copyrighted, © 1993 by 
  100.        Franz Schwarz, Mühlenstraße 2, D-78591 Durchhausen, Germany.
  101.           uucp: Franz.Schwarz@mil.ka.sub.org; Fido: 2:241/7506.18
  102.  
  103.  
  104. Suggestions, criticism, flames, money, gold, disks, beer, chocolate, nice
  105. postcards, e-mails, etc.  are welcomed and appreciated!;-)
  106.  
  107.  
  108.  
  109.     Bye
  110.       Franz 'Blacky' Schwarz
  111.  
  112.